2020.2

Itential Prospector

On this page:

Configuration

Configuration for Itential Prospector is stored in a JSON file located at /opt/prospector/current/properties.json.

Property Type Default Value Description
mongoSeeds array [ "localhost", "localhost:27018", ":" ] An array of MongoDB databases to connect to.
database string prospector The name of the MongoDB database to store Prospector data.
prospectorCollection string prospector_reports The name of the reports collection in the database.
sslEnabled boolean true Enable/disable SSL authentication.
sslKeyStore string ./prospector_keystore Path to a Java keystore.
sslKeyStorePassword string prospector Password for the Java keystore file.
sslInvalidHostNameAllowed boolean false Allow/deny invalid SSL hostnames.
authUsername string prospector Username for MongoDB authentication.
authPassword string prospector Password for MongoDB authentication.
authDatabase string prospector The name of the MongoDB database to authenticate against.

Sample Properties File

An example properties.json file is shown below.

$ cat /opt/prospector/current/properties.json
{    "mongoProps": {
        "mongoSeeds": [ “mongodb1:27017", “mongodb2:27017" ],
        "database": "prospector",
        "prospectorCollection": "prospector_reports",
        "sslEnabled": false,
        "sslKeyStore": "./prospector_keystore",
        "sslKeyStorePassword": "prospector",
        "sslInvalidHostNameAllowed": false,
        "authUsername": "prospector",
        "authPassword": "prospector",
        "authDatabase": "prospector"
    },
    "prospectorPort": 1849
}

If database authentication is not being used, remove the following attributes from the properties.

"authUsername": "prospector",
"authPassword": "prospector",
"authDatabase": "prospector"

Start Prospector

Run the following command to start Prospector.

sudo service prospector start

Stop Prospector

Run the following command to stop Prospector.

sudo service prospector stop

Verify Prospector Status

To verify the health of Prospector, run the following command.

$ sudo service prospector status
Redirecting to /bin/systemctl status prospector.service
● prospector.service - Prospector Daemon
   Loaded: loaded (/etc/systemd/system/prospector.service; enabled; vendor preset: disabled)
   Active: active (running) since Fri 2018-11-09 15:26:19 UTC; 2 weeks 4 days ago
Main PID: 693 (java)
   CGroup: /system.slice/prospector.service!"
            693 /usr/bin/java -jar prospector.jar 2>&1 > /var/log/prospector/prospector.log
Nov 09 15:26:28 localhost.localdomain java[693]: Nov 09, 2018 3:26:28 PMcom.mongodb.diagnostics.logging.JULLogger log
Nov 09 15:26:28 localhost.localdomain java[693]: INFO: Monitor thread successfully connectedto server with description ServerDescription{address=localhost:37017, type=STANDALONE,state=CONNECTED,...anos=13941747}
Nov 09 15:26:28 localhost.localdomain java[693]: Nov 09, 2018 3:26:28 PMcom.mongodb.diagnostics.logging.JULLogger log
Nov 09 15:26:28 localhost.localdomain java[693]: INFO: Discovered cluster type of STANDALONE
Nov 09 15:26:28 localhost.localdomain java[693]: Nov 09, 2018 3:26:28 PMcom.mongodb.diagnostics.logging.JULLogger log
Nov 09 15:26:28 localhost.localdomain java[693]: INFO: Opened connection[connectionId{localValue:17, serverValue:2}] to localhost:37017
Nov 09 15:26:30 localhost.localdomain java[693]: Found Collection: (prospector_reports)document count: 23
Nov 09 15:26:30 localhost.localdomain java[693]: Prospector is online, and looking for goldenconfigs
Nov 09 16:13:02 localhost.localdomain java[693]: Nov 09, 2018 4:13:02 PMcom.mongodb.diagnostics.logging.JULLogger log
Nov 09 16:13:02 localhost.localdomain java[693]: INFO: Opened connection[connectionId{localValue:18, serverValue:15}] to localhost:37017
Hint: Some lines were ellipsized, use -l to show in full.